Crate usvg

source ·
Expand description

usvg (micro SVG) is an SVG parser that tries to solve most of SVG complexity.

SVG is notoriously hard to parse. usvg presents a layer between an XML library and a potential SVG rendering library. It will parse an input SVG into a strongly-typed tree structure were all the elements, attributes, references and other SVG features are already resolved and presented in a simplest way possible. So a caller doesn’t have to worry about most of the issues related to SVG parsing and can focus just on the rendering part.

Features

  • All supported attributes are resolved. No need to worry about inheritable, implicit and default attributes
  • CSS will be applied
  • Only simple paths
    • Basic shapes (like rect and circle) will be converted into paths
    • Paths contain only absolute MoveTo, LineTo, CurveTo and ClosePath segments. ArcTo, implicit and relative segments will be converted
  • use will be resolved and replaced with the reference content
  • Nested svg will be resolved
  • Invalid, malformed elements will be removed
  • Relative length units (mm, em, etc.) will be converted into pixels/points
  • External images will be loaded
  • Internal, base64 images will be decoded
  • Dummy groups will be removed
  • All references (like #elem and url(#elem)) will be resolved
  • switch will be resolved
  • Text elements, which are probably the hardest part of SVG, will be completely resolved. This includes all the attributes resolving, whitespaces preprocessing (xml:space), text chunks and spans resolving
  • Markers will be converted into regular elements. No need to place them manually
  • All filters are supported. Including filter functions, like filter="contrast(50%)"
  • Recursive elements will be detected an removed

Limitations

  • Unsupported SVG features will be ignored
  • CSS support is minimal
  • Only static SVG features, e.g. no a, view, cursor, script, no events and no animations

Re-exports

pub use roxmltree;

Modules

filter
A collection of SVG filters.
utils
Some useful utilities.

Structs

AspectRatio
Representation of the preserveAspectRatio attribute.
BaseGradient
A generic gradient.
CharacterPosition
A text character position.
ClipPath
A clip-path element.
Color
A 8-bit RGB color.
EnableBackground
An enable-background.
Fill
A fill style.
Font
Text font properties.
Group
A group container.
Image
A raster image element.
ImageHrefResolver
An xlink:href resolver for <image> elements.
LinearGradient
A linear gradient.
Mask
A mask element.
NonZeroF64
A non-zero f64.
NonZeroPositiveF64
An immutable, finite f64 that is known to be > 0.
NormalizedF64
An immutable, finite f64 in a 0..=1 range.
Options
Processing options.
Path
A path element.
PathBbox
A path bbox representation.
PathData
An SVG path data container.
PathSegmentsIter
A path segments iterator.
Pattern
A pattern element.
Point
A 2D point representation.
PositiveF64
An immutable, finite f64 that is known to be >= 0.
RadialGradient
A radial gradient.
Rect
A rect representation.
ScreenRect
A 2D screen rect representation.
ScreenSize
A 2D screen size representation.
Size
A 2D size representation.
Stop
Gradient’s stop element.
Stroke
A stroke style.
StrokeMiterlimit
A stroke-miterlimit value.
Text
A text element.
TextChunk
A text chunk.
TextDecoration
A text span decoration.
TextDecorationStyle
A text span decoration style.
TextPath
A path used by text-on-path.
TextSpan
A text style span.
Transform
Representation of the <transform> type.
TransformedPath
An iterator over transformed path segments.
Tree
A nodes tree container.
ViewBox
View box.

Enums

Align
Representation of the align value of the preserveAspectRatio attribute.
AlignmentBaseline
An alignment baseline property.
BaselineShift
A baseline shift property.
BlendMode
A blending mode property.
DominantBaseline
A dominant baseline property.
Error
List of all errors.
FillRule
A fill rule.
FitTo
Image fit options.
ImageKind
An embedded image kind.
ImageRendering
An image rendering method.
LengthAdjust
A length adjust property.
LineCap
A line cap.
LineJoin
A line join.
NodeKind
Node’s kind.
Paint
A paint style.
PaintOrder
Representation of the paint-order property.
PathCommand
A path command.
PathSegment
A path’s absolute segment.
ShapeRendering
A shape rendering method.
SpreadMethod
A spread method.
Stretch
A font stretch property.
Style
A font style property.
TextAnchor
A text chunk anchor property.
TextFlow
A text chunk flow property.
TextRendering
A text rendering method.
Units
An element units.
Visibility
A visibility property.
WritingMode
A writing mode.

Traits

ApproxEq
A trait for approximate equality comparisons.
ApproxEqUlps
ApproxEqUlps is a trait for approximate equality comparisons. The associated type Flt is a floating point type which implements Ulps, and is required so that this trait can be implemented for compound types (e.g. vectors), not just for the floats themselves.
FuzzyEq
A trait for fuzzy/approximate equality comparisons of float numbers.
FuzzyZero
A trait for fuzzy/approximate comparisons of float numbers.
IsDefault
Checks that type has a default value.
IsValidLength
Checks that the current number is > 0.
NodeExt
Additional Node methods.

Functions

decompress_svgz
Decompresses an SVGZ file.

Type Definitions

ImageHrefDataResolverFn
A shorthand for ImageHrefResolver’s data function.
ImageHrefStringResolverFn
A shorthand for ImageHrefResolver’s string function.
Node
Alias for rctree::Node<NodeKind>.
Opacity
An alias to NormalizedF64.
StopOffset
An alias to NormalizedF64.
StrokeWidth
An alias to NonZeroPositiveF64.